xml/Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents/WebJobsAuthenticationEventRequest`2.xml (146 lines of code) (raw):
<Type Name="WebJobsAuthenticationEventRequest<TResponse,TData>" FullName="Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest<TResponse,TData>">
<TypeSignature Language="C#" Value="public abstract class WebJobsAuthenticationEventRequest<TResponse,TData> : Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequestBase where TResponse : WebJobsAuthenticationEventResponse, new() where TData : WebJobsAuthenticationEventData" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit WebJobsAuthenticationEventRequest`2<.ctor (class Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse) TResponse, (class Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventData) TData> extends Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequestBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest`2" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class WebJobsAuthenticationEventRequest(Of TResponse, TData)
Inherits WebJobsAuthenticationEventRequestBase" />
<TypeSignature Language="F#" Value="type WebJobsAuthenticationEventRequest<'Response, 'Data (requires 'Response :> WebJobsAuthenticationEventResponse and 'Response : (new : unit -> 'Response) and 'Data :> WebJobsAuthenticationEventData)> = class
 inherit WebJobsAuthenticationEventRequestBase" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TResponse">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<BaseTypeName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse</BaseTypeName>
</Constraints>
</TypeParameter>
<TypeParameter Name="TData">
<Constraints>
<BaseTypeName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventData</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequestBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<typeparam name="TResponse">The EventResponse related to the request.</typeparam>
<typeparam name="TData">The EventData model related to the request.</typeparam>
<summary>The base class for all typed event requests and its related response and data model.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse" />
<altmember cref="T:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventData" />
</Docs>
<Members>
<Member MemberName="Completed">
<MemberSignature Language="C#" Value="public override Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse Completed ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse Completed() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest`2.Completed" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Completed () As WebJobsAuthenticationEventResponse" />
<MemberSignature Language="F#" Value="override this.Completed : unit -> Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse" Usage="webJobsAuthenticationEventRequest.Completed " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Validates the response and creates the IActionResult with the json payload based on the status of the request.</summary>
<returns>IActionResult based on the EventStatus (UnauthorizedResult, BadRequestObjectResult or JsonResult).</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public TData Data { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TData Data" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest`2.Data" />
<MemberSignature Language="VB.NET" Value="Public Property Data As TData" />
<MemberSignature Language="F#" Value="member this.Data : 'Data with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest<'Response, 'Data (requires 'Response :> Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse and 'Response : (new : unit -> 'Response) and 'Data :> Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventData)>.Data" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DataAnnotations.Required]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DataAnnotations.Required>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("data")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("data")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>TData</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the related EventData model.</summary>
<value>The Json payload.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Failed">
<MemberSignature Language="C#" Value="public override Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse Failed (Exception exception);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse Failed(class System.Exception exception) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest`2.Failed(System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Failed (exception As Exception) As WebJobsAuthenticationEventResponse" />
<MemberSignature Language="F#" Value="override this.Failed : Exception -> Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse" Usage="webJobsAuthenticationEventRequest.Failed exception" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="exception" Type="System.Exception" />
</Parameters>
<Docs>
<param name="exception">The exception that is thrown</param>
<summary>
Sets the response statuscode, reason phrase and body when we want to return failed.
</summary>
<returns>An authenticationeventresponse task</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Response">
<MemberSignature Language="C#" Value="public TResponse Response { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TResponse Response" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest`2.Response" />
<MemberSignature Language="VB.NET" Value="Public Property Response As TResponse" />
<MemberSignature Language="F#" Value="member this.Response : 'Response with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventRequest<'Response, 'Data (requires 'Response :> Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventResponse and 'Response : (new : unit -> 'Response) and 'Data :> Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents.WebJobsAuthenticationEventData)>.Response" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("response")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("response")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>TResponse</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the related EventResponse object.</summary>
<value>The response.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>